Git Product home page Git Product logo

asteroidos.org's Introduction

asteroidos.org

Official website and documentation for AsteroidOS

Quickstart

You can build and run a local copy of the web site on your own computer. See https://asteroidos.org/wiki/localweb/ for details.

License

This website is a fork of lesscss.org

Copyright (c) 2017, Florent Revest, Alexis Sellier, Less Core Team, Contributors Content released under Creative Commons. Source code released under the MIT License.

asteroidos.org's People

Contributors

argosphil avatar beroset avatar chandlerswift avatar dependabot[bot] avatar docgalaxyblock avatar dodoradio avatar eltmosen avatar florentrevest avatar geckoeidechse avatar ilpianista avatar johnhammond avatar jrtberlin avatar kratz00 avatar lepras avatar littlefox94 avatar m4gnv5 avatar maalos avatar machin-shin avatar magnefire avatar mateossh avatar miathedev avatar r0nam1 avatar robje avatar rudloff avatar stefwe avatar t-vk avatar tambry avatar thelastproject avatar wannaphong avatar z3ntu avatar

Stargazers

 avatar  avatar  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  avatar

asteroidos.org's Issues

Improve font-style use

quick ideas to hold on

  • enlarge al floating text from 14px to 1em (16px in desktop view)
  • Select a noto sans style for the install feature support boxes
  • Select a noto font style for the community page headlines

Bluetooth PAN instructions don't work.

Apologies if this is not the best place to post such issues and let me know if this should be logged elsewhere.

Following /wiki/bluetooth/, everything goes fine until running:

./bt-pan --debug client MAC

At which point the command seems to complete successfully, with interface bnep0 being created. However, soon after it then disconnects.

In /var/log/messages just after connecting I see the line:

May 27 21:12:12 dory daemon.err connmand[328]: Can not request DHCP lease

And as it disconnects I see the lines:

May 27 21:12:12 dory daemon.info connmand[328]: (null) {del} route fe80:: gw :: scope 0
May 27 21:12:12 dory daemon.info systemd-networkd[279]: bnep0: Lost carrier
May 27 21:12:12 dory daemon.info connmand[328]: bnep0 {dellink} index 23 operstate 2

If I use hcitool cc to connect to the server I see the same behaviour โ€” it connects and then soon after disconnects.

The server is being run on a nearby Raspberry Pi.

The LG G watch is not paired with a phone at the time.

Update Porting Guide?

I have an old device that is smartwatch that I'd like to try to port asteroid too, however when I went to try to follow the porting guide, it looked like the link to the initial PR as an example and some of the file references no longer matched up?

This was in following the first steps at: Creating an OpenEmbedded BSP layer

Include a "discontinued" graphic or label for each watch in "Install" page

For newcomers that don't already have a smartwatch and are viewing the Install page, it is challenging to quickly find a supported/recommended watch to purchase.

One improvement that could easily check the last box is to add either a label or a graphic corresponding to each of the supported watches to indicate whether or not they are discontinued products. These indicators could be updated periodically (every few months?) to ensure that they remain generally accurate.

Provide the `sha256sum` information on the install pages

          Great idea! This makes me wonder if we should provide the `sha256sum` information on the install pages themselves too since we already know the checksums in advance: https://release.asteroidos.org/nightlies/beluga/MD5SUMS

(This also means that the We do not currently provide checksums for the files. claim, is incorrect ๐Ÿ˜‰ )

Originally posted by @MagneFire in #283 (comment)

Include a forums page

AsteroidOS needs a forum so that people can suggest features. People have mentioned this on reddit, and the IRC channel is basically dead, so that is useless. I can modify the CSS of some open source forum software, and with some time I might be able to make a frontend for a forum. either way, this is the most important feature that AsteroidOS needs right now.

Extending the current documentation and wiki

frequently, conversation comes up about documenting certain specifics about individual smartwatches. I personally agree with this, since it is difficult to find robust information on the internet, with certain watches only being covered in reviews that do not cover any technical aspects.

This would be quite a large addition to our documentation, so it is worth considering how we want to take this forward.

A few methods have been suggested to allow these pages to be added:

  • extend the current Documentation section on the website. This has the advantage of fitting comfortably into our current build system, and should give full control over the entire appearance and behaviour of the wiki pages, while providing a familiar markdown interface for implementing the content. The disadvantages are that 1) the documentation is difficult and unintuitive to edit, requiring use of github and standing in the way of spontaneous corrections or small additions. 2) beyond the most basic level of creating text-and-image articles, our current system is quite difficult to use. Any additions beyond the current templates require experience with javascript and html, and testing requires a local version of the website to be set up. While the website has been containerised, this setup is still quite a high bar for entry.
  • add an instance of a common wiki system, such as mediawiki. The main advantages come with on-the-fly what-you-see-is-what-you-get editing that doesn't require the use of git or a local website setup for editing, while using wiki definition languages common across many projects' documentation pages. There are also a few disadvantages: 1) mediawiki will never, without unreasonable time investment, have a look consistent with the main website. There are a lot of theming options that are not visually unappealing, but consistency is not really achievable.. 2) moderation becomes a far more serious problem than on github. Tampering will need to be fixed after the fact, instead of being stopped at the pull request stage. 3) mediawiki is very powerful, but some functionality can be considered as bloat.

I think that the wiki paradigm we choose now will be something that will be using for a very long time, so it is best to choose something that provides a good balance of customisation, functionality and extensibility

incorrect compiler name in documentation, links

The 0e82dc2 patch (that I submitted!) was wrong and it should be reverted in its entirety. The problem was that the build I was using. Specifically, I had started atop an old build, pulled from the git repo and rebuild and inadvertently discovered a bug in git ( https://bugzilla.redhat.com/show_bug.cgi?id=1803506 ) as a byproduct. I believe that was why my build differed. Many thanks to @MagneFire for correctly questioning this pull request. See https://github.com/AsteroidOS/asteroidos.org/pull/52/files

A page with things people are working on

Currently one has to skim through chats and github issues of AOS repos. But people have their own personal projects in their id's and one can not get a bird's eye view of things.

Things I think we should mention:

  1. title
  2. people working on it
  3. phase of project
  4. "This is an open source project so people are only giving their free time so no ETA's please" (If you want to give money etc etc :P)

Consolidate Templates by extending handle-bar use

This could be a good first step towards consolidating all these templates https://github.com/AsteroidOS/asteroidos.org/tree/master/templates/layouts which are out of control already.

Alternatively, I've been talking a lot about using conditionals like https://github.com/AsteroidOS/asteroidos.org/blob/master/templates/includes/documentation-header.hbs#L5 to make templates more dynamic based on parameters (here the condition is on the slug variable: https://github.com/AsteroidOS/asteroidos.org/blob/master/pages/wiki/documentation.md?plain=1#L3 but we could use arbitrary variables. For example, we could have

{{#is codename 'beluga'}}
  {{> bootloader-unlock-beluga}}
{{else}}
  {{> bootloader-unlock-aw }}
{{/is}}

Or

{{#is watch-needs-simg 'yes'}}
        <a class="btn btn-primary" href="https://release.asteroidos.org/nightlies/{{deviceName}}/asteroid-image-{{deviceName}}.simg" role="button">asteroid-image-{{deviceName}}.simg</a>
{{/is}}

Or {{#is two-columns 'yes'}} (for firefish/ray) etc... There is a balance to be found between using different templates or include blocks. For example, maybe the mtk-install is so different from the aw-install that they shouldn't be folded together, but maybe they should, I'm not sure about that one. But ultimately the goal should just be to 1- avoid duplication 2- Keep things modular and easy.

For example, one thing I find quite bizarre looking back on our code (I should have noticed it at the time of the pull request review :) ) is our empty watches.md https://raw.githubusercontent.com/AsteroidOS/asteroidos.org/master/pages/main/watches.md I would expect the content of that page to be in watches.md because this is just an empty body that gets included in https://github.com/AsteroidOS/asteroidos.org/blob/master/templates/layouts/watches.hbs#L33 (weirdly, just after the content of the page is defined in the layout...)

Similarly, we could hide the navbar of the documentation landing page only when {{#is slug 'documentation'}}.

I've been restraining from being too annoying with this but I really think we're at the point where this sort of consolidation is needed to keep the website easy to evolve uh.

The language used for all this templating is called HandleBars https://handlebarsjs.com/guide/#what-is-handlebars

Originally posted by @FlorentRevest in #285 (comment)

Make watch header refer to the compatible watches.

Currently we support watches that have multiple different revisions (examples: carp/smelt, catfish/catfish_ext/catshark, skipjack).

It is desirable to have the installation pages show these codenames too.
In addition, the actual watch names might make sense too (in the case for skipjack, it has a C2 and C2+ variant).

Add detailed git usage instruction to the Watchface Creation Guide

Following a discussion on matrix, saving the log here to salvage from:

Now, HOW TO PR:
You sure have cloned the Asteroid unofficial repo already, you can not directly pull request to that for security and ease of review reasons.

Fork the repo on the github web page, this will make a forked repo available under your personal github account.
Clone this personal fork with git clone https://github.com//unofficial-watchfaces
Now cd into this folder and set a remote so you can push to your repo from your local machine git remote set-url origin [email protected]:/unofficial-watchfaces.git
Create a branch for your changes (=New addition) git checkout -b analog-brawnish
This command also checks you out from master to the new branch, so your changes will not affect the master branch and you can always fetch changes from upstream to your fork.
Now copy your watchface to the other ones with the same folder and file structure.
git add analog-brawnish/ will add all new files and changes so you can commit them.
git commit -m "Add analog-brawnish " commits the added state so you can push to this commit your repo.
git push origin analog-brawnish will create the analog brawnish branch in your online repo from where you can pull request to AsteroidOS repos.
git checkout master will bring you back to the local master branch. Mind that your changes are not available in this master branch and it looks like the files are deleted. But those will "reappear when chekcing out between branches. Now you would be set to create another wathface branch from master, which is independed from analog-brawnish. Which makes it possible to have two pull requests open from the same fork, but different branches.
Now Pull request from the git website
Select the repo from your account, select the analog-brawnish branch from the tiny branch selector top-left.
Finally, hit "contribute" to open the Pull request dialog. Add a descripton, mind that the Header/Topic suggests what will happen when accepting your pull request. Like "Add watchface X /Change XY /Optimise X/". That way it will help to make the commit list easy to understand when browsing through later.
RE "git add analog-brawnish/ will add all new files and changes so you can commit them."
You will also need to add the ./thumbnails and README.md. Just Tabcomplpete your way through after git add. Tab completion will offer all remaing addable changes in the branch.
beroset
Good writeup! If that isn't already part of the "creating watchfaces" write up, perhaps it should be?
eLtMosen
My thoughts while writing ๐Ÿ˜…๐Ÿ˜ฌ
But from scratch, git init, key login and such are missing. I did all that initial setup long ago and just copy my .git folder between machines ๐Ÿ˜…
beroset
For that, you can point to github's instructions.

Freedom & Privacy

... this is what it says on your homepage regarding the wearable devices.
Regarding privacy, why is it that your homepage does requests to google-analytics.com and ajax.googleapis.com. There some other requests to CDNs as well. All of them are probably not protecting the privacy of your visitors.

Main FAQ page

Currently people who come to the website to find out about the OS might not have all their questions answered on the main page, and might not want to look into documentation as that can be intimidating. An FAQ exists on the install page but only gives information related to ports.

A proposed solution is a general FAQ. This could go in the top bar so it's easily found by anyone who is interested. Needs to answer at least the following, add more questions as needed.

  • what's the relationship of this to wearos (asteroidos is a linux distribution not android etc. (maybe talk about why we still have android code and libhybris))
  • why no android apps (we could do an android emulator but that's not worth the effort and adds google tracking etc.)
  • what about trackers (we don't do that (consider privacy implications of leftover android code and what it's actually used for))
  • can you port to this thing (check the porting status page)
  • what kind of apps are available in the repos
  • what features does wearos have that asteroid is missing? (consider accepting calls on watch etc.)
  • do we have cellular working on any watches - not sure about this one but I've seen it a few times on matrix and the subreddit

Add troubleshooting information for emulator

I had a hard time trying to get the emulator to compile and run correctly and discovered some things that may help others, such as how to resolve problems using QEMU with the proprietary NVIDIA driver. This kind of information should be included in the emulator page.

Add a legend to the features table

Now that we have good/bad/na/partial/unknown as possible status entries, it's no longer quite intuitive what the five different colors mean. We should add a legend and/or tooltips so that when you hover over a square, it tells you the status of that feature for that watch.

[bass] LG boot loop after following section 2a of install instructions

Watch model: bass
AsteroidOS Image: nightly
Host OS: Debian 10

After following section 2a of the installation instructions here, my watch enters a boot loop where the LG logo appears on the screen, goes away and reappears, and so on.

I have had this issue in the past when i first loaded AsteroidOS on my watch, and reproduced it again today. The solution to this situation has been to run fastboot flash boot ~/Downloads/zImage-dtb-bass.fastboot prior to fastboot flash userdata ~/Downloads/asteroid-image-bass.ext4.

I see that this section of the page is generated within a layout template affecting many watches. Is this in fact the correct order for other watches and just doesn't work for bass? I'm asking because I don't want to submit a pull request in a way that makes the documentation work for my watch model and not for the other watch models.

Consolidate watch feature information

The feature list for each watch is listed under the Install page for that watch. This is unwieldy and repetitive and does not easily allow for such things as a comparison page that shows all watches and features.

As a first step, it would be useful to gather all of the feature data into a .json file and then use that file with a helper to populate the existing pages.

The next step will be to create a page showing all watches and all features, perhaps allowing for the ability to select features of interest and filter watches based on that.

ADB reboot bootloader freezes

Hello,
After you install AsteroidOS on your device, in my case on a Asus Zenwatch 2 (sparrow). You can't use "adb reboot bootloader" anymore, it just freezes the terminal and the watch does nothing. Instead, you have to execute "adb shell reboot -f bootloader" in order to reboot into fastboot. I think this should be specify in the installation guide or fixed (best case).
Thank you

Include a watchfaces prototyping webpage

Currently, watchfaces can be prototyped from a computer using some hacks and wizardry described in the following documentation page. https://asteroidos.org/wiki/watchfaces-creation/
This requires a very complex development workflow including an entire SDK.
However, the QmlWeb project https://qmlweb.github.io/ provides an open source in-browser live coding platform that could easily be integrated in a webpage of asteroidos.org https://github.com/qmlweb/qmlweb.github.io/blob/master/index.html#L29 It would even remove the need for the background Image component and "new Date()" hacks.
Moreover, the webpage could export the .qml file and .jpg preview into a tarball that could be deployed on the watch.

Command "fasboot continue" forgot : smartwatch endless restarting

Hi,

Instead of typing "fastboot continue" at the end of the flashing process, i wrote "exit" at the "command line".

So now the smartwatch is restarting endlessly.

Can you tell me what i am supossed to do now to recover the smartwatch at a right state ?

Regards.

[FAQ] Reorder <h1> use and optimize FAQ title

@FlorentRevest via matrix:
we just have a h1 "faq" at the top which isn't useful given that there's already a "Frequently asked question" in the breadcrumb. and when the page is open, the left navigation bar only contains that h1 which makes it look a bit awkward. but as soon as one scrolls a little it, all the questions (h2) appear in the side bar. I propose we just make every question a h1 and drop that "FAQ" top level title in the document

Links to nightly builds are broken on the site.

All links to builds are broken on https://asteroidos.org/ site. Every link leads to a 404 site error. As I understand, those files haven't been published to release.asteroid.org yet.
Could you provide a list of GitHub links to real files if they exist?

Thanks beforehand for an answer and for your great work!

Battery Life Information for Watches

We should measure and include how long a charge lasts for each watch during normal use to make buying decisions simpler.
I'm not entirely sure where to put it. We have already a callout-info element, but I think that's a bit too eye-catching for basic information such as battery life.
Example:
image

Integrate model/product code and possibly more differentiating details for all watches

Currently, only some install pages have the product code of a watch mentioned in not so prominent place.
Product code however

  • Help users identify the watch exactly when purchasing
  • Free SEO regrading requests for product codes from search engines.
  • Generally give more detailed info on the watches and act as trusted source in the matter.

Lets discuss where to put this specific info. And possibly how to extend it to other details that differ between models like strap width and casing size.

This just to start off the product code collection, please do not mind the formating at all and ideally past your corrections in a better formated list ๐Ÿ˜…

โœ”๏ธ W100 = dory [LG G Watch]
โœ”๏ธ W110 = lenok [LG G Watch R]
โœ”๏ธ W150 = bass [LG G Watch Urbane]
โœ”๏ธLM-W315 = narwhal [LG Watch W7]

โœ”๏ธ 360L = smelt [Moto 360 2nd gen, 46mm, 20mm]
โœ”๏ธ 360S = carp [Moto 360 2nd gen, 42mm, 18mm]
โœ”๏ธ 360W = carp [Moto 360 2nd gen, 42mm, 16mm]
โœ”๏ธ 360SP = sportscarp [Moto 360 sports]

โœ”๏ธ WF11018 = catfish-ext [TicWatch Pro LTE]
โœ”๏ธ WF12096 = catfish [TicWatch Pro]
โœ”๏ธ WF12106 = catshark [TicWatch Pro 2020]
โœ”๏ธ WG12016 = tunny [TicWatch S2]
โœ”๏ธ WG12036 = skipjack [TicWatch C2/C2+]
โœ”๏ธ WF12086 = mooneye [TicWatch E]
โœ”๏ธ WF12066 = mooneye [TicWatch S]

โœ”๏ธ WI500Q = anthias [Asus ZenWatch]
โœ”๏ธ WI501Q = sparrow [Asus ZenWatch 2, 46mm]
โœ”๏ธ WI502Q = wren [Asus ZenWatch 2, 41mm]
โœ”๏ธ WI503Q = swift [Asus ZenWatch 3]

โœ”๏ธ LEO-BX9 = Sawfish [Huawei Watch 2]
โœ”๏ธ LEO-DLXX = Sawshark [Huawei Watch 2 LTE]

โœ”๏ธ DW6F1 = firefish [Fossil Gen4]
โœ”๏ธ DW7F1 = ray [Fossil Gen4]

โœ”๏ธ OW19W6 = beluga [OPPO Watch 41mm WiFi]
โœ”๏ธ OW19W8 = beluga [OPPO Watch 46mm Wifi]
โœ”๏ธ OW19W12 (untested) = belugaxl [OPPO Watch 46mm LTE]
โœ”๏ธ SWR50 = tetra [Sony Smartwatch 3]
โœ”๏ธ SM-R382 = sprat [Samsung Gear Live]

โœ”๏ธ W1 = sturgeon [Huawei Watch]
โœ”๏ธ DW6xx & DW7xx = ray and firefish [Fossil gen4]

To be cleared:

  • minnow [moto 360 gen 1]
  • harmony and inharmony based watches still missing details

Replace ClockworkMod UniversalAdbDriver with official google issued Android Platform-Tools ADB driver

Two users now reported the Windows ADB driver we link too does not work anymore. For one user, the official google platform-tools driver worked. The other case still in testing as i am writing this.

Problems is, where to find a linkable source for a compiled version of the driver.
Thats not from some shady google docs folder like this one:
https://drive.google.com/drive/folders/1H8DxaRta8gafcUA8bJqkajobnnfuw2et

Add more indepth information for app development/API usage.

Currently we have a wiki for creating an app for AsteroidOS: https://asteroidos.org/wiki/creating-an-asteroid-app/
While sufficient for simply building and creating a new app, it does not show what APIs are available for everyone to use.
Generally people have to search through this GitHub organization, which is not desirable.

Instead we should provide a new wiki page that provides this information.

Things that this page should have (more to be added/suggestions welcome ๐Ÿ˜‰ ):

  • Information on all qml components: These are also available here: https://doc.qt.io/qt-5/qtqml-index.html but we should provide a list of commonly used modules.
    • General modules:
      • Item
      • Rectangle
    • Watchface specific
      • Wallclock
      • Canvas
  • Provide information on how to use our custom QtSensors API (https://github.com/AsteroidOS/qtsensors).
  • Provide information on how to interact with the DBUS MCE API
  • Provide information around the generally used modules like: Nemo KeepAlive
  • Provide information on how to interact with Asteroid Launcher: How to catch display on/off events, ambient mode events.

Idea: multiple watch previews

As part of the recent unifying of watches the topic of different models with the same codename came up. There are multiple ports that are compatible with different models (ray, firefish, harmony, inharmony).
An idea was to somehow show the different models that are compatible with a series of watches. Like the preview below:

aos-web-watch-preview.mp4

I have the code WIP here: https://github.com/MagneFire/asteroidos.org/tree/feature/watch-previews

I'm just not sure if we want to take this route, hence this issue. A discussion on this would be great ๐Ÿ˜„

Change watch rating

The recommended watches are the LG G Watch Urbane (bass) and the Huawei Watch (sturgeon).

Simply looking at the install page(https://asteroidos.org/install/) does not highlight this.

I think we should come up with a better method to distinguish the most recommended watches.

I purpose the following two changes:

Move to five star rating

Currently, there are watches that have the 3 stars while not being on-par with bass and sturgeon (harmony and smelt).
While others have 2 stars but have some essential features missing (swift, mooneye) others seems perfectly capable (wren, sparrow).

What do you think of the following:
1 star (horrible, has some serious issues): tetra
2 stars (ok, but missing some essential features (Bluetooth)): swift, mooneye
3 stars (good, but misses some great features (Always-on-Display, Tilt-to-wake, etc)): anthias, dory, (in)harmony
4 stars (Great, minor things are missing (microphone)): smelt, lenok, sparrow, wren
5 Excellent (No missing features): bass, sturgeon

Change watch order to star based

Instead of alphabetically ordering the watches. The best supported watches will be the first in the list, no need to scroll down.

Please let me know what you think of this. Other suggestions are also welcome ๐Ÿ˜‰

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.