readme

README.md

@@ -0,0 +1,67 @@
+# joomer-ftxui-file-browser
+Terminal User Interface for file browsing using ftxui
+
+# Demonstrates
+- file navigation
+
+# Usage
+
+```
+   joomer-ftxui-file-browser [path]
+- use arrow keys or mouse to navigate directories
+- alternatively you can press the numbers on your keyboard to select directories
+```
+
+[todo] 
+- create windows version 
+- add numbers to select
+- display file size 
+- indicate its a folder in some way
+
+# Build 
+```
+learndir/
+└── FTXUI/
+└── joomer-ftxui-file-browser/
+└── vcpkg/
+```
+
+## Ubuntu Linux (kasm-ubuntu)
+```
+mkdir learndir
+cd learndir
+git clone https://github.com/ArthurSonzogni/FTXUI
+cd FTXUI
+mkdir build
+cd build
+cmake ..
+cmake --build . --config Release
+cd ..
+git clone https://git.indoodle.com/jason/joomer-ftxui-file-browser.git
+cd joomer-ftxui-file-browser
+make all
+bin/Linux/release/joomer-ftxui-file-browser
+```
+
+## Windows (win10 enterprise)
+- Download Visual Studio Community Edition 2022
+- Run VisualStudioSetup.exe
+- Workload = [x] Desktop developemnt with C++
+- Individial components = [x] Git For Windows
+- cmake
+
+Run **x64 Native Tools Command Prompt for VS 2022**
+```
+mkdir learndir
+cd learndir
+git clone https://github.com/microsoft/vcpkg
+cd vcpkg
+vcpkg install ftxui:x64-windows --triplet x64-windows
+cd ..
+git clone https://git.indoodle.com/jason/joomer-ftxui-file-browser.git
+cd joomer-ftxui-file-browser
+msbuild joomer-ftxui-file-browser.vcxproj /t:Rebuild /p:Configuration=Debug /p:Platform=x64
+bin\Debug\joomer-ftxui-file-browser.exe
+```
+
+