From c46df0a2a85b1d777f20927bbcb9612680b2fd38 Mon Sep 17 00:00:00 2001 From: jaseg Date: Sun, 8 Jul 2018 13:03:17 +0200 Subject: setup.py: Make README fit for PyPI --- README.rst | 34 +++++++++++++++++----------------- setup.py | 11 +++++++++-- 2 files changed, 26 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 2ff0e45..c72bab5 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ Gerbolyze high-resolution image-to-PCB converter ================================================ -.. image:: sample.jpg +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/sample.jpg Tooling for PCB art is quite limited in both open source and closed source ecosystems. Something as simple as putting a pretty picture on a PCB can be an extremely tedious task. Depending on the PCB tool used, various arcane incantations @@ -42,33 +42,33 @@ Nice black-and-white images can be generated from any grayscale image using the ``gerbolyze render`` will automatically scale the render such that ten pixels in the render correspond to 6mil on the board, which is about the smallest detail most manufacturers can resolve on the silkscreen layer. You can control this setting using the ``--fab-resolution`` and ``--oversampling`` options. Refer to ``gerbolyze --help`` for details. -.. image:: screenshots/01import01.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/01import01.png 2 Import your desired artwork ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Though anime or manga pictures are highly recommended, you can use any image including photographs. Be careful to select a picture with comparatively low detail that remains recognizable at very low resolution. While working on a screen this is hard to vizualize, but the grain resulting from the low resolution of a PCB's silkscreen is quite coarse. -.. image:: screenshots/02import02.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/02import02.png 3 Paste the artwork onto the render as a new layer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. image:: screenshots/03paste.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/03paste.png 4 Scale, rotate and position the artwork to the desired size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. image:: screenshots/04scale_cut.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/04scale_cut.png For alignment it may help to set the artwork layer's mode in the layers dialog to ``overlay``, which makes the PCB render layer below shine through more. If you can't set the layer's mode, make sure you have actually made a new layer from the floating selection you get when pasting one image into another in the GIMP. -.. image:: screenshots/05position.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/05position.png 5 Convert the image to grayscale ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. image:: screenshots/06grayscale.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/06grayscale.png 6 Fine-tune the image's contrast ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -77,7 +77,7 @@ To look well on the PCB, contrast is critical. If your source image is in color, When using the GIMP's newsprint filter, bright grays close to white and dark grays close to black will cause very small dots that might be beyond your PCB manufacturer's maximum resolution. To control this case, add two steps to the grayscale value curve as in the picture below. These steps saturate very bright grays to white and very dark grays to black while preserving the values in the middle. -.. image:: screenshots/08curve_cut.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/08curve_cut.png 7 Retouch details ~~~~~~~~~~~~~~~~~ @@ -86,11 +86,11 @@ Therer might be small details that don't look right yet, such as the image's bac If you don't want the image's background to show up on the final PCB at all, just make it black. -.. image:: screenshots/09retouch.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/09retouch.png In the following example, I retouched the highlights in the hair of the character in the picture to make them completely white instead of light-gray, so they still stand out nicely in the finished picture. -.. image:: screenshots/10retouched.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/10retouched.png 8 Run the newsprint filter ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -101,24 +101,24 @@ The first important settings is the spot size, which should be larger than your The second important setting is oversampling, which should be set to four or slightly higher. This improves the result of the edge reconstruction of ``gerbolyze vectorize``. -.. image:: screenshots/11newsprint.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/11newsprint.png The following are examples on the detail resulting from the newsprint filter. -.. image:: screenshots/12newsprint.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/12newsprint.png -.. image:: screenshots/13newsprint.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/13newsprint.png -.. image:: screenshots/14newsprint.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/14newsprint.png 9 Export the image for use with ``gerbolyze vectorize`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Simply export the image as a PNG file. Below are some pictures of the output ``gerbolyze vectorize`` produced for this example. -.. image:: screenshots/14result_cut.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/14result_cut.png -.. image:: screenshots/15result_cut.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/15result_cut.png -.. image:: screenshots/16result_cut.png +.. image:: https://raw.githubusercontent.com/jaseg/gerbolyze/master/screenshots/16result_cut.png diff --git a/setup.py b/setup.py index 27c7d26..fa82b9d 100755 --- a/setup.py +++ b/setup.py @@ -1,14 +1,21 @@ #!/usr/bin/env python3 -from setuptools import setup, find_packages +from setuptools import setup + +def readme(): + with open('README.rst') as f: + return f.read() + setup( name = 'gerbolyze', - version = '0.1.0', + version = '0.1.6', py_modules = ['gerbolyze'], scripts = ['gerbolyze'], description = ('A high-resolution image-to-PCB converter. Gerbolyze reads and vectorizes black-and-white raster ' 'images, then plots the vectorized image into an existing gerber file while avoiding existing features such as ' 'text or holes.'), + long_description=readme(), + long_description_content_type='text/x-rst', url = 'https://github.com/jaseg/gerbolyze', author = 'jaseg', author_email = 'github@jaseg.net', -- cgit