Doc changes

Signed-off-by: Matthew Ballance <matt.ballance@gmail.com>

Author: mballance

doc/source/getting_started.rst

@@ -0,0 +1,54 @@
+#########################
+Getting Started with IVPM
+#########################
+
+Installing IVPM
+***************
+
+IVPM must be installed before it can be used to work with a project. Typically,
+the easiest approach is to install IVPM as a user-installed package:
+
+..code-block:: bash
+
+    % python3 -m pip install --user ivpm
+
+Once this is done, you can invoke IVPM either via the entry-point script (ivpm)
+or as a Python module:
+
+..code-block:: bash
+
+    % ivpm --help
+    % python3 -m ivpm --help
+
+Initializing an Exiting IVPM Project
+************************************
+After fetching the source for an IVPM-enabled project, the `ivpm update` command
+is used to fetch source dependencies and initialize a Python virtual environment
+for the project.
+
+The IVPM project, itself, is IVPM-enabled. The steps to fetch and initialize
+the project are shown below (assuming ivpm has already been installed):
+
+..code-block:: bash
+
+    % git clone https://github.com/fvutils/ivpm
+    % cd ivpm
+    % ivpm update
+
+Note that, by default, IVPM clones sub-projects using your ssh public key. If
+this key has not been registered with a Git server, then cloning any projects
+from that server will fail. Git projects can be cloned using https 
+(ie anonymously) by running `ivpm update -a`.
+
+IVPM performs the following tasks as a part of the `update` operation:
+- Fetches the source for each dependent project (eg .git, .tar.gz, .jar, etc)
+- Identifies dependent projects that are, themselves, IVPM-enabled and 
+  determines sub-dependencies
+- Identifies dependent projects that are Python projects and dependencies 
+  from PyPi. Installs these into the project-local Python virtual 
+  environment, with source projects installed in `editable` mode.
+
+Initializing a New IVPM Project
+*******************************
+
+

doc/source/imgs/IVPM_System_Diagram.png

@@ -11,6 +11,7 @@ Welcome to IVPM's documentation!
    :caption: Contents:
 
    introduction
+   getting_started
    reference
 
 

doc/source/index.rst

@@ -9,6 +9,8 @@ lightweight project-local package manager. It excels at
 managing projects where dependencies are co-developed with
 the project. 
 
+.. image:: imgs/IVPM_System_Diagram.png
+
 Let's look at a simple example. A System-on-Chip 
 (SoC) design targeting an FPGA or an ASIC is composed of
 multiple IPs written in a hardware-description language (HDL)
@@ -47,4 +49,12 @@ original developers.
   create a project that contains all its required 
   dependencies.
 
+- IVPM provides build/release utilities for C/C++ packages
+  that provide a Python interface
+
+- IVPM provides features for discovering source and library paths
+  across Python and non-Python packages. This support is 
+  currently focused on the needs of managing FuseSoC libraries.
+
+
 

doc/source/introduction.rst

@@ -22,7 +22,8 @@ def __call__(self, args):
         # TODO: allow override    
         proj = os.getcwd()
 
-        ivpm_dir = os.path.dirname(os.path.realpath(__file__))
+        ivpm_dir = os.path.dirname(
+            os.path.dirname(os.path.realpath(__file__)))
         templates_dir = os.path.join(ivpm_dir, "templates")
 
         for src,dir in zip(["ivpm.yaml"], [""]):

src/ivpm/cmds/cmd_init.py

@@ -3,9 +3,12 @@
 #*****************************************************************************
 package:
    name: ${name}
-   version: ${version}
+
+   dep-sets:
+
+   - name: default
+     deps: []
+
+   - name: default-dev
+     deps: [] 
 
-   deps:
-   
-   dev-deps:
-