Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebastian-goeldi
sebastian-goeldi committed Jul 23, 2019
1 parent d700fe1 commit 8bb2cdb
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ KLayoutPhotonicPCells core Package

This package extends KLayout with photonic PCells. Namely it provides the possibility to create ports. Ports in comparison to pins of electronics have additionally to the position also a direction and length. Furthermore, this package allows to build hierarchical PCells. These allow instantiating other PCells and connect them via ports or position them relativ to the coordinate system of the parent PCell.

The full pdf-documentation is in the [doc](https://github.com/sebastian-goeldi/KLayoutPhotonicPCells-core/blob/master/doc/build/latex/KLayoutPhotonicPCells.pdf) folder. Otherwise, the full documentation can be found as a sphinx website at doc/build/html/index.html .
The full documentation is in the [docs](https://github.com/sebastian-goeldi/KLayoutPhotonicPCells-core/blob/master/docs/) folder. It is available as a sphinx html documentation at docs/index.html . A [pdf](https://github.com/sebastian-goeldi/KLayoutPhotonicPCells-core/blob/master/docs/KLayoutPhotonicPCells.pdf) version is available in the docs folder, too.

Online documentation is available on [GitHub Pages](https://sebastian-goeldi.github.io/KLayoutPhotonicPCells-core/)
4 changes: 2 additions & 2 deletions grain.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<api-version>0.25</api-version>
<title>KLayout Photonic PCells Core</title>
<doc>KLayout Photonic PCells introduces the concept of ports to KLayout. Ports in contrast to pins also track directions. Additionally, PCells can be built hierarchically from other PCells and new shapes. The sub-cells can be connected to each other through ports.</doc>
<doc-url>https://github.com/sebastian-goeldi/KLayoutPhotonicPCells-core/blob/master/doc/build/latex/KLayoutPhotonicPCells.pdf</doc-url>
<url/>
<doc-url>https://sebastian-goeldi.github.io/KLayoutPhotonicPCells-core/</doc-url>
<url>https://github.com/sebastian-goeldi/KLayoutPhotonicPCells-core</url>
<license>AGPLv3</license>
<author>Sebastian Goeldi</author>
<author-contact>sebastian.goeldi@protonmail.com</author-contact>
Expand Down

0 comments on commit 8bb2cdb

Please sign in to comment.