Skip to content

Commit

Permalink
Update links to doxygen documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ubruhin committed Aug 11, 2018
1 parent afe76c6 commit 31550f4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- Open a new issue for your idea, assuming one does not already exist.
- Fork the repository on GitHub.
- Have a look at our [development resources](https://github.com/LibrePCB/LibrePCB/tree/master/dev),
especially at the [Doxygen documentation](https://doxygen.librepcb.org/master/).
especially at the [Doxygen documentation](https://doxygen.librepcb.org/).
- When using QtCreator, import and use our [code style guide file](https://github.com/LibrePCB/LibrePCB/blob/master/dev/CodingStyle_QtCreator.xml).

## Making Changes
Expand All @@ -27,7 +27,7 @@
- To quickly create a topic branch based on master:
`git checkout -b my_contribution master`
- Please avoid working directly on the `master` branch.
- Write code which follows our [code style guides](https://doxygen.librepcb.org/master/df/d24/doc_code_style_guide.html)
- Write code which follows our [code style guides](https://doxygen.librepcb.org/df/d24/doc_code_style_guide.html)
and [.editorconfig settings](https://github.com/LibrePCB/LibrePCB/blob/master/.editorconfig).
- Make commits of logical units.
- Make sure your commit messages are in the [proper format](http://chris.beams.io/posts/git-commit/):
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Contributions are welcome! See our [Contributing Guide](CONTRIBUTING.md) for
details.

For internal details take a look at the
[automatically generated documentation (doxygen)](https://doxygen.librepcb.org/master/)
[automatically generated documentation (doxygen)](https://doxygen.librepcb.org/)

## Development

Expand Down
6 changes: 5 additions & 1 deletion dev/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# Development Resources

This directory contains various resources for developers:

- A [demo workspace](https://github.com/LibrePCB/demo-workspace) for testing LibrePCB
- Some diagrams about the software architecture (class diagrams, library architecture diagrams, ...)
- Docker containers
- [Doxygen documentation](https://doxygen.librepcb.org/master/)
- [Doxygen documentation](https://doxygen.librepcb.org/)
([all branches](https://doxygen.librepcb.org/_branches/))
- and more...


Useful Links:

- [Gerber File Format:](https://www.ucamco.com/en/guest/downloads) [Specifications](https://www.ucamco.com/files/downloads/file/81/the_gerber_file_format_specification.pdf) | [PCB Fabrication Data Guide](https://www.ucamco.com/files/downloads/file/130/pcb%20fabrication%20data%20-%20a%20guide.pdf)
- Excellon File Format: http://web.archive.org/web/20071030075236/http://www.excellon.com/manuals/program.htm
- Online 3D PCB Viewer: http://mayhewlabs.com/webGerber/

0 comments on commit 31550f4

Please sign in to comment.