Skip to content
This repository has been archived by the owner on Feb 4, 2021. It is now read-only.

Soup of the README.md #31

Open
luzpaz opened this issue Oct 19, 2019 · 3 comments · Fixed by #32
Open

Soup of the README.md #31

luzpaz opened this issue Oct 19, 2019 · 3 comments · Fixed by #32

Comments

@luzpaz
Copy link
Contributor

luzpaz commented Oct 19, 2019

Would you mind if I took a crack at organizing and formatting the README.md file ?
@KeithSloan
Copy link
Owner

No please do. It has grown organically and I hate writing docs.

luzpaz added a commit to luzpaz/FreeCAD_Python_GDML that referenced this issue Oct 19, 2019
@luzpaz
README.md: Modernize and format with correct markdown
3b82072 
Closes KeithSloan#31  
* FIx some typos  
* Create new sections
* Attempted to make the content a little clearer
@luzpaz luzpaz mentioned this issue Oct 19, 2019
Merged
@luzpaz
Copy link
Contributor Author

luzpaz commented Oct 19, 2019

Before PR is merged a few things are needed:

  • Better description of what the workbench does
  • What is softLinks and why does it need sudo ??
  • Some screenshots
  • perhaps a short animated screencast showing the gist of what the WB can do
  • consider moving to a release model
  • license section

@luzpaz
Copy link
Contributor Author

luzpaz commented Oct 19, 2019

Please reopen issue, thanks

@KeithSloan KeithSloan reopened this Oct 19, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

README.md: Modernize and format with correct markdown luzpaz/FreeCAD_Python_GDML
2 participants
@KeithSloan @luzpaz