]> Nutra Git (v2) - nutratech/usda-sqlite.git/commitdiff
update readme
authorShane Jaroch <chown_tee@proton.me>
Thu, 18 Apr 2024 16:25:10 +0000 (12:25 -0400)
committerShane Jaroch <chown_tee@proton.me>
Thu, 18 Apr 2024 16:25:10 +0000 (12:25 -0400)
README.rst

index a3e006ef9b2d3ee4f1b578d6f1d7ae3744c8dffc..7b457bda5c2d974473030c09f0640e65d732fedd 100644 (file)
@@ -12,6 +12,7 @@ See CLI:        https://github.com/nutratech/cli
 See nt-sqlite:  https://github.com/nutratech/nt-sqlite
 
 
+
 Building the database
 #########################
 
@@ -30,6 +31,7 @@ Building the database
     bash setup.sh
     python3 process.py
 
+
 3. If you are committing database changes, add a line to
    :code:`sql/version.csv` (e.g. :code:`id=3` is the latest in this case).
 
@@ -43,7 +45,8 @@ Building the database
 | 3   | 0.0.2    | Thu 06 Aug 2020 09:21:39 AM EDT   |
 +-----+----------+-----------------------------------+
 
-4. i. (Optional) Enforce foreign keys with your ``~/.sqliterc`` file,
+
+4. i. *(Optional)* Enforce FKs by copying this to your ``~/.sqliterc`` file.
 
 .. code-block:: text
 
@@ -51,24 +54,19 @@ Building the database
     .mode column
     PRAGMA foreign_keys = 1;
 
-4. ii. Create the database with
+4. ii. Create the database.
 
 .. code-block:: bash
 
   make build
 
 
-5. Verify the tables (inside an SQL shell: :code:`sqlite3 sql/usda.sqlite3`),
+5. Verify the tables.
 
 .. code-block:: sql
 
-  .tables
+  make test
 
-  SELECT * FROM nutr_def WHERE id=328;
-  SELECT long_desc FROM food_des WHERE id=9050;
-  SELECT * FROM version;
-
-  .exit
 
 6. If everything looks good, upload compressed
    :code:`dist/nutra-X.X.X.db.tar.xz` file to binary host.
@@ -78,6 +76,7 @@ Building the database
   make deploy/upload
 
 
+
 Tables (Relational Design)
 ##########################