Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write user guide / tutorial #32

Open
lam2mo opened this issue Jan 31, 2019 · 7 comments
Open

Write user guide / tutorial #32

lam2mo opened this issue Jan 31, 2019 · 7 comments
Labels

Comments

@lam2mo
Copy link
Member

lam2mo commented Jan 31, 2019

Right now folks have to look at the examples to see what syntax constructs are valid in Less-Java. As more people get involved, we should have a short FAQ or tutorial or guide or quick reference or something that shows the basic syntax of Less-Java and helps on-board people who have had experience with Java or C.

This could go on the wiki.

@lam2mo
Copy link
Member Author

lam2mo commented Feb 1, 2019

@jennahorrall is working on this here: https://github.com/JMU-CS/less-java/wiki/Tutorial

@Zamua
Copy link
Contributor

Zamua commented Feb 1, 2019

May also be worth moving the Zamua updates page somewhere else since it's a little out of place now. Or I suppose we can add pages for all of the contributors.

@lam2mo
Copy link
Member Author

lam2mo commented Feb 1, 2019

Yeah, I guess I had imagined making one for each student who does an honors thesis as a sort of record of what they've done. Maybe clean them up a bit afterwards and remove dates. Feel free to do that for yours if you like.

@Zamua
Copy link
Contributor

Zamua commented Feb 8, 2019

Have we decided on how to write/host the documentation?
I like readthedocs.

@lam2mo
Copy link
Member Author

lam2mo commented Feb 8, 2019

I'm not sure there's really a need for a separate host for now; the wiki formatting seems nice enough and it keeps the code and the documentation together in one place.

@Zamua
Copy link
Contributor

Zamua commented Feb 10, 2019

Sounds good! Yeah on second thought the GitHub wiki formatting is pretty nice

@lam2mo
Copy link
Member Author

lam2mo commented Apr 23, 2020

@MrBartWolf make sure wrapper script options and else if are documented. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants