István Palócz
bdeb07691a
Fix URL typo in the README ( #4415 )
...
Missing the r letter is in the /contributing/
2020-12-01 15:41:47 +01:00
Nathan Lovato
87a87205fb
Rewrite contributing/index, rename pages, update references
2020-11-13 14:15:35 -06:00
Nathan Lovato
1827f10937
Edit contributing guidelines
...
Add links to the README
Simplify building the manual
Update class reference writing guidelines based on review notes. Re-add lost changes in rebase.
Address review comments in documentation guidelines
2020-11-13 10:58:46 -06:00
Nathan Lovato
d74261bfb5
Move docs contribution guides from the README to Contributing
...
- Edited building_the_manual to make the content more explicit
- Added some links to the README to help them get started contributing
2020-11-12 09:17:25 -06:00
Nathan Lovato
9df8c5c383
Edit content guidelines, remove typographic marks
...
- Removed typographic marks in the entire repo
- Removed a line about why we don't use a wiki
- Indented notes with 4 spaces
- Addressed review comments
2020-11-12 08:59:13 -06:00
Nathan Lovato
b3caa1b07e
Add content guidelines and other guidelines to the README
2020-11-12 08:59:12 -06:00
Hugo Locurcio
290bc5ebdc
Document how to rebuild the documentation automatically on changes
...
This speeds up the iteration workflow significantly when working
on new pages.
2020-09-29 12:02:50 +02:00
Hugo Locurcio
424f81ca85
Document theming customizations in the README
...
This is a relatively important caveat in the documentation,
so it's worth mentioning in the README.
2020-08-06 18:54:18 +02:00
Hugo Locurcio
47b0721d8a
Capitalize all instances of Git in the documentation
2020-05-23 18:34:55 +02:00
Hugo Locurcio
d494d19dac
Remove trailing whitespace and irregular whitespace
2020-05-17 00:26:19 +02:00
Hugo Locurcio
f361118a8f
Install dependencies from requirements.txt when using virtualenv
2020-04-22 16:25:31 +02:00
Rémi Verschelde
ac5aa6cd1e
Improve docs about compilation toolchain requirements
...
Add mention about installing Python 3-flavored SCons with
pip for Linux distros which still only provide a Python 2 build
(e.g. Ubuntu 18.04).
2020-03-25 15:05:14 +01:00
Rémi Verschelde
74ec5d6942
Document installation of requirements.txt with pip
...
Also pin their versions to the same ones as used on RTD.
Follow-up to #3276 .
2020-03-17 10:58:43 +01:00
Hugo Locurcio
6b3ed0474c
Mention RAM requirements for building using Sphinx
...
This closes #3239 .
2020-03-04 09:50:06 +01:00
Wilson E. Alvarez
d13551a274
Added current memory issue at build time to README ( #3175 )
2020-02-15 20:43:16 +01:00
Martin Zabinski
d1a9f2e54f
fix 2 dead links in README.md
2019-11-24 20:23:44 +01:00
Rémi Verschelde
1a8d981080
Add link to classref howto
...
Fixes #2417 .
2019-04-29 10:21:42 +02:00
Rémi Verschelde
a95cd08285
Use HTTPS for links which support it
2018-12-13 12:06:02 +01:00
Rémi Verschelde
9bfc111547
Add full text of CC-BY-3.0 license
2018-12-07 21:47:49 +01:00
Rémi Verschelde
4ef06a4135
Removing trailing whitespace
...
With `sed -i $(rg -l '[[:blank:]]*$' -g'!classes') -e 's/[[:blank:]]*$//g'`
2018-11-20 11:08:34 +01:00
m
affa0f3542
Added example for binding to external C++ libary #513
...
Updated the custom C++ modules documentation with an example of binding to an external C++ library, using the Festival text-to-speech library.
2018-11-10 19:15:12 -05:00
Joe Sweeney
fe76bef199
British to American spelling ( #1837 )
...
* British to American spelling
2018-10-21 21:51:57 +02:00
mhilbrunner
f215a0cf26
Proofing/review: Remove filler words, adhere to style guide
2018-05-06 05:23:37 +02:00
Max Hilbrunner
4cb983d24b
README: Add note about branches
2018-02-13 00:10:14 +01:00
Max Hilbrunner
7498882455
Update README: Add info about make.bat, MinGW
2018-01-26 15:00:53 +01:00
Todd Ross
bd6d57392f
update Sphinx build instructions
2018-01-10 13:54:47 -06:00
Rémi Verschelde
6d46511200
Edit instructions regarding adding images and files
2017-10-14 14:41:44 +02:00
Ralph Minderhoud
9fa995b9c7
Fixed broken README link to XML class references
2017-09-15 14:22:54 -05:00
Hugo Locurcio
8d4a6f4b0e
Some styling and wording fixes in README.md
...
python -> Python where appropriate.
2016-10-23 00:48:32 +02:00
maximelore
d51ca576ac
Add building on windows section to README
2016-10-16 12:48:05 +02:00
est31
ff6cd639f9
Add virtualenv info to README
...
Also add env/ directory to gitignore for the virtual environment.
And add commonly used temporary files as well.
2016-02-22 20:38:40 +01:00
Rémi Verschelde
55d459ed68
Reorder sections in readme
...
Thus making it clearer that classes/ files should not be touched.
2016-02-17 13:39:00 +01:00
Rémi Verschelde
2816a3054e
Add instructions on how to build and contribute
...
+ license
2016-02-11 10:23:06 +01:00
Rémi Verschelde
86563cc374
Import first batch of pages
2016-02-08 18:24:54 +01:00