Commit graph

21 commits

Author SHA1 Message Date
Jason Villanueva
6d8e8a5bcf
Create CONTRIBUTING.md (#1460) 2021-05-04 11:52:36 +05:30
Leo Torres
aa561c027a
Make the README point to the RTD docs (#383)
Update readme to contain links the RTD docs. Move contributing.md to the docs.
2020-08-31 17:39:10 -04:00
leotrs
2c94a5c792 Make it so that the config module is reachable, as _config. This is used e.g. in the docs. This also fixes an image path in docs/source/contributing.md. 2020-08-24 08:27:32 -04:00
Leo Torres
271c235f78
Documentation: finish quickstart and add installation instructions (#324)
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments

* document config system and general changes in the description of each command line flag

* run black

* MacOS

* update

* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.

* add the symlinks

* fix length of underlines

* update contributing guidelines

* convert quickstart doc from md to rst. Also add a troubleshooting stub file

* finish the second part of the quickstart

* add general and linux instructions

* add mac instructions

* add windows install instructions

* final touches

* Update docs/source/installation/win.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update a_deeper_look.rst

added explanation on the  ``-s`` flag

* Update docs/source/installation/installation_linux.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update docs/source/installation/win.rst

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* updates from code review

* update from code review

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
2020-08-21 20:40:27 -04:00
Leo Torres
35e9e05eec
Update contributing guidelines (#311)
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments

* document config system and general changes in the description of each command line flag

* run black

* MacOS

* update

* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.

* add the symlinks

* fix length of underlines

* update contributing guidelines

* Update CONTRIBUTING.md

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* Update CONTRIBUTING.md

Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>

* fix indices

* some updates from the team

* update document

* Update CONTRIBUTING.md

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update CONTRIBUTING.md

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* update

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
2020-08-20 09:59:58 -04:00
Leo Torres
54854ccf23
Documenting the config system (#303)
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments

* document config system and general changes in the description of each command line flag

* run black

* MacOS

* update

* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.

* add the symlinks

* fix length of underlines

Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
2020-08-16 07:08:26 -04:00
Aathish
a468992cd1
Remove a reference to Travis in CONTRIBUTING.md
There was a note asking the contributor to add `[skip ci]` to their commit if they did not modify any code that will be run.
Since we're not using Travis anymore, it's pointless to have this note in here.
2020-07-25 19:08:27 +05:30
Pg Biel
d0aecfce36
Update CONTRIBUTING.md 2020-06-14 02:05:38 -03:00
Aathish
76657ec04f
Added request for testing to General Contribution Guidelines
Added a note in the ManimCommunity Contribution Guidelines to do the same as well.
2020-06-14 10:33:55 +05:30
Aathish
b277c0aaf1
Added instruction to test changes locally before taking a PR. [skip ci]
W.R.T #152 
Added instructions for the contributor to test their changes locally, and to write tests if adding a new feature.

Should close #152 .
2020-06-14 09:50:31 +05:30
Safin Singh
d0018008db
Update CONTRIBUTING.md 2020-06-06 18:59:49 -07:00
Syrus Dark
554714c0c2
Merge branch 'contrib-guide' of https://github.com/naveen521kk/manim into contrib-guide 2020-06-05 18:54:18 +05:30
Syrus Dark
038936bec3
Change name 2020-06-05 18:53:22 +05:30
Pg Biel
f22311974c
dot 2020-06-04 10:55:58 -03:00
Syrus Dark
8537939854
Update with asked changes 2020-06-03 20:50:17 +05:30
Pg Biel
b462fc298f
names 2020-06-03 11:44:03 -03:00
Syrus Dark
7a9ace4281
Add General Contribution 2020-06-03 20:11:40 +05:30
Syrus Dark
8c6bca84dc
Change \ to / 2020-06-03 20:00:11 +05:30
Syrus Dark
4d3ce59612
Fix image path 2020-06-03 19:55:49 +05:30
Syrus Dark
52794cfa5b
Changes as Requested 2020-06-03 19:48:34 +05:30
Syrus Dark
2b5e209da2 Move to CONTRIBUTING.md 2020-06-03 17:18:08 +05:30