Improve setup workflow and README
- Add automatic theme installation to venv target - Simplify README to single-command setup - Achieve perfect 69 lines in README - Make development setup fully automated
This commit is contained in:
parent
776a4a07f4
commit
e08019dd8b
2 changed files with 20 additions and 16 deletions
33
README.rst
33
README.rst
|
|
@ -19,34 +19,32 @@ Try running:
|
|||
development
|
||||
===============================
|
||||
|
||||
Clone this repo, then in the ``pelican-themes`` directory clone this repo:
|
||||
**Setup (one command does everything):**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
cd pelican-themes
|
||||
git clone git@github.com:russellballestrini/pelican-svbhack.git
|
||||
cd ..
|
||||
make venv
|
||||
|
||||
To install this theme:
|
||||
This creates a ``venv/`` directory with Pelican, installs all dependencies, clones the theme, and configures everything automatically.
|
||||
|
||||
**Testing workflow (ALWAYS test before committing):**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
pelican-themes -i pelican-themes/pelican-svbhack/
|
||||
make clean && make html && make serve
|
||||
|
||||
This builds the site and serves it at http://localhost:8000
|
||||
|
||||
Next clone the `pelican-plugins` repo (I use ``random_article``)
|
||||
**Available commands:**
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone git@github.com:getpelican/pelican-plugins.git
|
||||
|
||||
In development I use a ``make`` file to hold common build and test commands::
|
||||
|
||||
make clean && make html && make serve
|
||||
|
||||
I also manage my resume using ``.rst`` and I use the ``rst2pdf`` tool to turn it into a ``.pdf``::
|
||||
|
||||
make clean && make html && make resume
|
||||
make venv # Setup virtual environment
|
||||
make html # Build the site
|
||||
make clean # Remove output directory
|
||||
make serve # Serve site at localhost:8000
|
||||
make devserver # Serve with auto-reload
|
||||
make resume # Generate PDF resume
|
||||
|
||||
|
||||
|
||||
|
|
@ -66,3 +64,6 @@ For example: `Remarkbox comments <https://www.remarkbox.com>`_.
|
|||
you should check out https://uncloseai.com for machine learning on your static web pages!
|
||||
|
||||
now with translation services!
|
||||
|
||||
nice,
|
||||
dude
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue