Update readme, remove cli

HugoTini · Aug 7, 2022 · 544036b · 544036b
1 parent 014ed57
commit 544036b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 97 deletions.
diff --git a/cli.md b/cli.md
diff --git a/deepbump_cli.py b/deepbump_cli.py
diff --git a/readme.md b/readme.md
@@ -2,35 +2,29 @@
 
 # DeepBump
 
-DeepBump is a tool to generate normal maps from single 
-pictures. See this [blog post](https://hugotini.github.io/deepbump) 
-for an introduction. It can be used either as a Blender add-on or 
-as a command-line program.
+DeepBump is a machine-learning driven tool to generate normal & height maps from single pictures. See this [blog post](https://hugotini.github.io/deepbump) for an introduction.
 
 # Installation
 
 1) [Download DeepBump as a ZIP](https://github.com/HugoTini/DeepBump/releases).
 
-2) In Blender, go to _Edit -> Preferences -> Add-ons -> Install_ 
-and select the downloaded ZIP file. Then enable the add-on.
+2) In Blender, go to _Edit -> Preferences -> Add-ons -> Install_ and select the downloaded ZIP file. Then enable the add-on.
 
-3) In the add-on preference, click the '_Install dependencies_' button (this 
-requires an internet connection and might take a while).
-
-By installing those dependencies, be aware of 
-[Microsoft conditions](https://github.com/microsoft/onnxruntime/blob/master/docs/Privacy.md). 
-This add-on use available APIs to disable telemetry.
+3) In the add-on preference, click the '_Install dependencies_' button (this requires an internet connection and might take a while).
 
+By installing those dependencies, be aware of [Microsoft conditions](https://github.com/microsoft/onnxruntime/blob/master/docs/Privacy.md). This add-on use available APIs to disable telemetry.
 
 # Usage
 
 Check the [blog post](https://hugotini.github.io/deepbump) first video.
 
-In the Shader Editor, select an _Image Texture Node_ and 
-click _Generate Normal Map_ in the right panel under 
-the _DeepBump_ tab.
+In the Shader Editor, in the right panel under the _DeepBump_ tab:
+
+**Color (albedo) → Normals** : Select a color image node and click _Generate Normal Map_.
+
+**Normals → Height (displacement)** : Select the generated normal map image node and click _Generate Height Map_.
 
-(For advanced usage, see [cli.md](cli.md) for the command-line interface.)
+**Normals → Curvature** : Select the generated normal map image node and click _Generate Curvature Map_.
 
 # License