Giter Site home page Giter Site logo

hellosystem / docs Goto Github PK

View Code? Open in Web Editor NEW
20.0 5.0 23.0 3.68 MB

This repository builds the documentation for hello

Home Page: https://hellosystem.github.io/docs/

License: BSD 2-Clause "Simplified" License

Makefile 5.80% Python 26.22% Shell 33.37% HTML 9.20% CSS 25.42%
hellosystem

docs's Introduction

hello Documentation

This repository builds the documentation for hello.

It uses Sphinx, recommonmark, and GitHub Actions to produce documentation from the Markdown source files in this repository.

Local development server

Use a local development server that regenerates the output whenever the input changes:

sudo pkg install -y py37-pip gmake # on FreeBSD, e.g., on helloSystem
pip-3.7 install -r requirements.txt
export GITHUB_REPOSITORY="helloSystem/docs"
export PATH=~/.local/bin/:$PATH
gmake watch

Now open http://127.0.0.1:8000 in a web browser. It will be regenerated and refreshed whenever one of the input files changes.

Local output generation

One can also generate documentation in various output formats locally:

sudo pkg install -y py37-pip gmake # on FreeBSD, e.g., on helloSystem
pip-3.7 install -r requirements.txt
export GITHUB_REPOSITORY="helloSystem/docs"
export PATH=~/.local/bin/:$PATH
gmake html
gmake epub
gmake html
gmake qthelp
qmake # list more output formats

docs's People

Contributors

9gay avatar abby2k1 avatar aki-k avatar andrewimeson avatar benwaffle avatar bitigchi avatar dsk502 avatar grahamperrin avatar heidiwenger avatar jsoref avatar kokakoda avatar laerte avatar marklapointe avatar midnadimple avatar osbre avatar pcvm avatar probonopd avatar rilian-la-te avatar sporiff avatar theassassin avatar trivoxel avatar tuskpot avatar zaynetro avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

docs's Issues

index page is rendering the wrong img src of screenshot

hey just noticed a small issue,

src for the screenshot should be

https://raw.githubusercontent.com/helloSystem/hello/master/screenshots/20211219-desktop-0.7.png

instead of https://github.com/helloSystem/hello/blob/master/screenshots/20211219-desktop-0.7.png

Explain compatiblity libraries

Documentation currently says

Applications compiled on one major version of FreeBSD are expected to run on subsequent major versions of FreeBSD if compatiblity libraries are installed. Example: An application compiled on FreeBSD 3.2 is expected to run on FreeBSD 14 if compatiblity libraries are installed.

We should explain this using a practical example.
https://www.cinelerra-gg.org/freebsd-package/ seems to require siome libraries in versions older than what currently ships with helloSystem.

What are the exact steps to make it run?

Related:
helloSystem/launch#1 (comment)

Contextualise the project's uses of Python

No mention of Python at https://github.com/helloSystem/hello/wiki/Welcome-and-unwelcome-technologies – consider adding a few words here.

Re: #8 whilst I can't seek Python, I do see (for example) PyQt mentioned at https://hellosystem.github.io/docs/developer/applications.html


https://www.reddit.com/r/freebsd/comments/klvrwd/-/ghdow08/

We'd need someone with a great conceptual understanding of … and ideally some Python skills to get it moving faster. …

https://www.reddit.com/r/freebsd/comments/kkk5ia/-/ghf4jro/?context=2

I like the philosophy, but "written in python" is a no go from me.

From the linked helloSystem: Three-layer UX design philosophy for Simplicity and Power … on Medium:

… many applications can be right-clicked to reveal their source code. This is because they are written in Python, … the Python example, …

Provide offline version of the documentation

In countries like mine, the internet connection is not something that is easy to get or very cheap, so having a help and needing to be connected every time it is needed would be great.

Qt Assistant: Cannot open qhc file

LANG=C assistant -collectionFile /home/user/Downloads/helloSystem.qhc

Error registering documentation file '/home/user/Downloads/helloSystem.qch': Cannot open documentation file /home/user/Downloads/helloSystem.qch.

cc @TheAssassin

My findings

HWPROBE LINK ADDRESS: https://bsd-hardware.info/?probe=9a7f08f8c1
Mar 11, 2021, 10:23am
Booted from ISO helloSystem build: 0E27 for commit: de9b15f

  1. booted OK
  2. screen OK
  3. Keyboard OK but had to set to UK via Utilities
  4. Ethernet works
    WiFi no driver in free BSD
  5. Touchpad not working
  6. See https://bsd-hardware.info/?probe=9a7f08f8c1 for HWProbe
  7. Installed and updated Falkon and FreeBSD
  8. No sound via Browser
  9. Welcome sound OK
  10. Overall nice atmosphere for a Desktop.
    I am amazed that FreeBSD has no drivers for Intel WiFi and Synaptic touchpad!
    helloSystem is an incredible effort to achieve what I have been trying with Linux and BSD fora long time.
    WiFi and Synaptic touchpad drivers /modules for freeBSD needed.

Tutorial: How to configure Ibus or fcitx input method for HelloSystem?

Hello, current i am linux user. i am good at using ubuntu .
I would like to try HelloSystem, install it on my laptop.
I am trying to figure out how to setup a chinese input method.
I often told we can using Ibus or Fcitx.
How to set up it on HelloSystem.
Need some document to description us how to do it ,thanks.

Be more descriptive about live boot single user mode peculiarities

From https://hellosystem.github.io/docs/developer/boot.html#boot-into-verbose-single-user-mode:

… This allows advanced users, administrators, and developers to inspect the Live system early boot process and to enter commands manually that would otherwise be executed automatically. …

Advanced users may be surprised that exit from single user mode does not enter multi-user mode; that uname(1) and vi(1) are unusable; and so on.

Please consider adding a little more to the documentation. Thanks.

Docs & MIDI - no MIDI messages.

Under "Using /dev/umidi* - Testing", an explaination is needed as to what to do to diagnose if no MIDI messages appear on the terminal, despite positive output of #doas dmesg | tail and $ ls /dev/ | grep umidi.

Likewise, it should be noted that the command "fluidsynth -m oss -a oss SoundFont.sf2" kicks up an error as fluidsynth is not shipped with a soundfont and is looking for one at (which doesn't exist): /usr/local/share/soundfonts/default.sf2
While soundfonts reside in: /usr/local/share/sounds/sf2/ as per:
# pkg install fluid-soundfont
An explaination is needed as how to get fluidsynth to look in the correct place...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.