Mercurial > web-octave
annotate contribute.md @ 49:d01bb705165e kai
Markdownify pages.
author | Kai T. Ohlhus <k.ohlhus@gmail.com> |
---|---|
date | Wed, 28 Sep 2016 11:29:58 +0200 |
parents | 171ca967fcc9 |
children |
rev | line source |
---|---|
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
1 --- |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
2 layout: default |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
3 title: Contribute |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
4 menu: true |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
5 --- |
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
6 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
7 We always need more help improving Octave and there are many ways |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
8 you can contribute. You can help by fixing bugs, developing new |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
9 features, answering questions on the mailing list or IRC channel, |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
10 helping to improve the web pages. |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
11 |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
12 If you are wondering what to work on, we have a standard answer: |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
13 what would you like to work on? We try not to tell contributors |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
14 what to work on as most people do their best work when they are |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
15 within their own field of interest. So, we would love your help, |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
16 but would also love for you to work on what you love. |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
17 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
18 If you need some inspiration, we do maintain a |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
19 <a href="http://www.octave.org/wiki/Projects">list of possible projects</a> |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
20 on the Wiki. |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
21 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
22 If you have an idea on what to contribute, then join the |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
23 maintainers mailing list and discuss your ideas there. That way |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
24 others can provide input early on, which makes your contribution |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
25 more likely to get accepted. |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
26 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
27 |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
28 ## Contacting developers |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
29 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
30 If you want to participate in Octave development, you should join |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
31 the <a href="https://lists.gnu.org/mailman/listinfo/octave-maintainers"> |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
32 <code>maintainers@octave.org</code></a> mailing list. <b>Please |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
33 use this list only if you are participating in Octave's |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
34 development.</b> If you are looking for help in using Octave, |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
35 please use the <a href="https://lists.gnu.org/mailman/listinfo/help-octave"><code>help@octave.org</code></a> |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
36 list instead, or check out other <a href="support.html">support |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
37 options</a>. |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
38 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
39 For sometimes faster communication, you can also chat in IRC |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
40 in <code>#octave</code> in Freenode. Note, however, that the primary |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
41 medium for development talk is the mailing list. |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
42 |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
43 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
44 ## Using the Development Sources |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
45 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
46 The latest development sources of Octave are also available via |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
47 <a href="http://www.selenic.com/mercurial/wiki">Mercurial</a> (hg) |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
48 archive. |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
49 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
50 The primary archive address |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
51 is <a href="http://www.octave.org/hg/octave">http://www.octave.org/hg/octave</a>, |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
52 which currently redirects |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
53 to <a href="http://hg.savannah.gnu.org/hgweb/octave">http://hg.savannah.gnu.org/hgweb/octave</a>. |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
54 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
55 If you decide to use the development sources from the Mercurial |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
56 archive, please read the |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
57 file <a href="http://www.octave.org/hg/octave/file/tip/etc/HACKING"><code>etc/HACKING</code></a> |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
58 that is available with the source files. |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
59 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
60 Assuming you have Mercurial and git installed on your machine you |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
61 may obtain the latest development version of Octave sources with |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
62 the following command: |
5
e210b708b330
fill in site content
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
diff
changeset
|
63 |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
64 {% highlight text %} |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
65 hg clone http://www.octave.org/hg/octave |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
66 {% endhighlight %} |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
67 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
68 This will clone <em>two</em> repositories, one of which is |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
69 subrepository of the main Octave repository. Once you have these, |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
70 you can resync with the archive by doing |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
71 |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
72 {% highlight text %} |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
73 hg -v pull |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
74 hg -v update |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
75 {% endhighlight %} |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
76 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
77 The `-v` option is not required but provides extra information |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
78 about what was pulled and updated. The Octave manual has more |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
79 information about <a href="doc/interpreter/Contributing-Guidelines.html#Contributing-Guidelines">contributing |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
80 to Octave's development</a>. |
18
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
81 |
46
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
82 |
171ca967fcc9
Start new development branch closer to the current website,
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
43
diff
changeset
|
83 ## Octave Forge |
18
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
84 |
43
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
85 The community-developed [Octave-Forge][forge] packages expand Octave's core |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
86 functionality by providing field specific features via Octave's package system. |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
87 For example, image and signal processing, fuzzy logic, instrument control, |
a1cb50997055
Reviewed and reformatted some files.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
25
diff
changeset
|
88 and statistics packages are examples of individual Octave-Forge packages. |
18
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
89 |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
90 [forge]: http://octave.sourceforge.net/ |
011b5099594e
add octave-forge links
Alex Krolick <whokilledtheelectricmonk@gmail.com>
parents:
10
diff
changeset
|
91 [forge-packages]: http://octave.sourceforge.net/packages.php |