rattail/rattail-tutorial
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add instructions to clone rattail-tutorial src

Browse source 
user may just want to do that, instead of making a new project
This commit is contained in:
Lance Edgar 2019-08-16 21:52:20 -05:00
parent 491d3da582
commit 42c1adc8f8
2 changed files with 21 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/create-project.rst
View file

@ -7,8 +7,11 @@ Create a New Project
Now that you've setup your development environment, you're ready to create a
new Rattail-based project.
.. todo::
link to dev env setup doc here?
.. note::
If you wish to simply install and run this rattail-tutorial project,
*instead* of creating a new project for yourself, please keep reading. This
document aims to address both use cases. However you can skip ahead to
:ref:`mkvirtualenv`.
Note again that while Rattail is a project in itself, your app is yet another
project, which is "based" on Rattail but otherwise has a life of its own. It
@ -71,6 +74,8 @@ This sort of brings us to the second point about names, which is that they
link to "how to name project" doc
(https://rattailproject.org/moin/LilSnippets/ProjectNaming)
.. _mkvirtualenv:
Creating the Virtual Environment
--------------------------------
@ -107,22 +112,26 @@ Or maybe ``workon poser`` etc., whatever named env you want to activate.
Installing Rattail Packages
---------------------------
If you're just wanting to run the rattail-tutorial app instead of creating your
own project, you can skip this step.
At this point you have an "empty" virtual environment, to which we will now
install some Rattail software packages.
But in this tutorial we're showing how to do it all, and so before we can
create the tutorial project itself we must first install some Rattail packages
to our virtual environment. Well really there's just one (Tailbone) which is
needed because it contains the "rattail" scaffold, and also it depends on other
packages (namely, Pyramid) which are needed for the scaffold feature::
If you are wanting to create a new project for yourself, then the only thing
you must do for this step is::
pip install Tailbone
However if you're not wanting a new project, but wish to run this
rattail-tutorial app instead, you should do this::
mkdir -p ~/src
cd ~/src
git clone https://rattailproject.org/git/rattail-tutorial.git
pip install -e rattail-tutorial
Creating the Project
--------------------
Again if you're just wanting to run the rattail-tutorial app you can skip this
step.
If you're just wanting to run the rattail-tutorial app you can skip this step.
First of all you should change directory to wherever you want to create the
actual project source folder. Rattail docs will generally assume that's at

2
docs/setup-dev.rst
View file

@ -156,7 +156,7 @@ Setting It Up
To make sure you have Python 3.x, run the following command::
sudo apt install -y python3
sudo apt install -y python3 python3-dev
Confirming It Works
^^^^^^^^^^^^^^^^^^^