summaryrefslogtreecommitdiffstats
path: root/GUI
diff options
context:
space:
mode:
authoryum <yum.food.vr@gmail.com>2022-12-17 17:26:16 -0800
committeryum <yum.food.vr@gmail.com>2022-12-17 17:26:16 -0800
commit4d836989720523cd0363927e3e066f56b9dc445c (patch)
treef7a9ff7cb50eda1ff29e91c78067dcc5e0ce6233 /GUI
parentda754e9cf5b192239826aa1619e1ada3c98daa45 (diff)
Check in `future` package
I hit some issues installing Whisper and had to embed this package. I haven't taken the time to deeply understand what's going on. I think that embedded Python follows different rules about resolving module paths than regular system Python. Basically, `future`'s setup.py has a line like `import src`, where `src` is a module inside future (like `future/src/__init__.py`). This doesn't work unless we put that directory on the search path.
Diffstat (limited to 'GUI')
-rw-r--r--GUI/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/GUI/README.md b/GUI/README.md
index 18b6a35..b03cace 100644
--- a/GUI/README.md
+++ b/GUI/README.md
@@ -21,6 +21,25 @@
actually distribute all our transitive dependencies. This also keeps
the package size small.
+## C++ Style
+
+Follow the Google C++ style guide. This is not absolutely strict but
+it will be used to settle arguments.
+
+https://google.github.io/styleguide/cppguide.html
+
+This should get you 80% of the way there:
+
+* When in doubt, use K&R style
+* 2 space indents
+* Class members `look_like_this_`
+* Functions and methods `LookLikeThis()`
+* Local variables `look_like_this`
+* Global constexprs `kLookLikeThis`
+
+Consistent style reduces cognitive burden. Follow it for the benefit of
+your peers.
+
## How the embedded python environment works
I'm distributing an embeddable version of python from the official
@@ -35,6 +54,10 @@ cd TaSTT
./Resources/Python/python.exe -m pip install $YOUR\_PACKAGE\_HERE
```
+The `future` package imports extra modules, and the embedded python
+search path needs to be told where that is. For that reason, we also
+redistribute the `future` package in source format.
+
This is logically what the GUI does internally when it creates the
python environment.