nilix/onyx
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

rename project to just 'onyx'

Browse source
This commit is contained in:
Iris Lightshard 2022-08-28 12:24:11 -06:00
parent de8d3ad63b
commit 1a0497887a
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398
5 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,12 +1,12 @@
# onyx/scry # onyx
## about ## about
`onyx/scry` is a lightweight map annotation and location data management and sharing tool built using [leaflet](https://leafletjs.com) and [typescript](https://typescriptlang.org). It is intended as a standalone tool to generate, manage, and share simple location data in the form of points, circles, and paths (polylines and polygons). All of these have associated titles and descriptions and can be easily imported from or exported to JSON format for easy sharing. All data is saved locally via the `localStorage` API, and the only network calls are those to retrieve either the streetmap or satellite tile data (and of course geolocation if you opt in). `onyx` is a lightweight map annotation and location data management and sharing tool built using [leaflet](https://leafletjs.com) and [typescript](https://typescriptlang.org). It is intended as a standalone tool to generate, manage, and share simple location data in the form of points, circles, and paths (polylines and polygons). All of these have associated titles and descriptions and can be easily imported from or exported to JSON format for easy sharing. All data is saved locally via the `localStorage` API, and the only network calls are those to retrieve either the streetmap or satellite tile data (and of course geolocation if you opt in).
## usage ## usage
__note__: On mobile, for best experience you should "install to home screen" or "create shortcut" from your browser of choice, so that you can use `onyx/scry` as an app without the browser UI getting in the way. __note__: On mobile, for best experience you should "install to home screen" or "create shortcut" from your browser of choice, so that you can use `onyx` as an app without the browser UI getting in the way.
When you launch the application for the first time (and subsequent times if you don't set `home`), it will ask for your current location to set the `home` point. If you deny permission or it can't determinte your location, you can set it later via the menu and the map will zoom out to fit the entire Earth. When you launch the application for the first time (and subsequent times if you don't set `home`), it will ask for your current location to set the `home` point. If you deny permission or it can't determinte your location, you can set it later via the menu and the map will zoom out to fit the entire Earth.
@ -58,9 +58,9 @@ When importing, the imported data is added to the current overlays. If you want
## build/deploy ## build/deploy
If you want to hack on `onyx-scry` and rebuild it, I recommend rebuilding the `sourcemapper` (written in `go`) in the `buildtools` directory first (in case your `glibc` version is older). If you want to hack on `onyx` and rebuild it, I recommend rebuilding the `sourcemapper` (written in `go`) in the `buildtools` directory first (in case your `glibc` version is older).
The build process for `onyx-scry` is a bit unorthodox. Instead of using modules, the `typescript` code is all concatenated before transpiling. The `sourcemapper` is used to show lines in the original source where transpilation errors occured, in a plumbable address format so you can right-click in `acme` and go directly to that line of code. The build process for `onyx` is a bit unorthodox. Instead of using modules, the `typescript` code is all concatenated before transpiling. The `sourcemapper` is used to show lines in the original source where transpilation errors occured, in a plumbable address format so you can right-click in `acme` and go directly to that line of code.
From the `src` directory, you can just run `./build.sh`. Once built, the final `javascript` file is located in the `static` directory with the rest of the application. From the `src` directory, you can just run `./build.sh`. Once built, the final `javascript` file is located in the `static` directory with the rest of the application.
@ -68,6 +68,6 @@ Deploying is simple: just serve the `static` directory.
## license ## license
`onyx/scry` is distributed under the [MIT license](./LICENSE) - basically do whatever you want with it but leave my name on it. `onyx` is distributed under the [MIT license](./LICENSE) - basically do whatever you want with it but leave my name on it.
`leaflet` is distributed under a similar [2-clause BSD license](./LEAFLET-LICENSE). `leaflet` is distributed under a similar [2-clause BSD license](./LEAFLET-LICENSE).

2
src/99-onyx-scry.ts → src/99-onyx.ts
View file

@ -1,4 +1,4 @@
const helpLink = "<br>ONYX/scry v0.2.0 [ <a target='_blank' href='https://nilfm.cc/git/onyx-scry/about/LICENSE'>license</a> | <a target='_blank' href='https://nilfm.cc/git/onyx-scry/about'>manual</a> ]"; const helpLink = "<br>ONYX v0.3.0 [ <a target='_blank' href='https://nilfm.cc/git/onyx/about/LICENSE'>license</a> | <a target='_blank' href='https://nilfm.cc/git/onyx/about'>manual</a> ]";
function init(): void { function init(): void {

2
src/build.sh
View file

@ -1,7 +1,7 @@
#!/bin/sh #!/bin/sh
# default program name # default program name
progname="onyx-scry" progname="onyx"
# or use first cmd line arg # or use first cmd line arg
if [ ! -z "$1" ]; then if [ ! -z "$1" ]; then

10
static/index.html
View file

@ -5,17 +5,17 @@
<meta name='description' content='map annotation tool'/> <meta name='description' content='map annotation tool'/>
<meta name='viewport' content='width=device-width,initial-scale=1'> <meta name='viewport' content='width=device-width,initial-scale=1'>
<link rel='stylesheet' type="text/css" href="./leaflet.css"> <link rel='stylesheet' type="text/css" href="./leaflet.css">
<link rel='stylesheet' type='text/css' href='./style.css?v=0.2.0'> <link rel='stylesheet' type='text/css' href='./style.css?v=0.2.1'>
<meta name="apple-mobile-web-app-capable" content="yes" /> <meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="mobile-web-app-capable" content="yes" /> <meta name="mobile-web-app-capable" content="yes" />
<link rel='shortcut icon' href='/favicon.png'> <link rel='shortcut icon' href='/favicon.png'>
<link rel='manifest' href='/manifest.json'> <link rel='manifest' href='/manifest.json'>
<title>ONYX/scry</title> <title>ONYX</title>
</head> </head>
<body> <body>
<noscript> <noscript>
<div id="noscript-container"> <div id="noscript-container">
<p>This is a javascript application - <a href="https://nilfm.cc/git/onyx-scry">ONYX/scry</a>;</p> <p>This is a javascript application - <a href="https://nilfm.cc/git/onyx">ONYX</a>;</p>
<p>You must enable javascript in your browser to use it.</p> <p>You must enable javascript in your browser to use it.</p>
</div> </div>
</noscript> </noscript>
@ -111,6 +111,6 @@
</div> </div>
</body> </body>
<script src="./leaflet.js"></script> <script src="./leaflet.js?v=1.8.0"></script>
<script src="./onyx-scry.js"></script> <script src="./onyx.js?v=0.2.1"></script>
</html> </html>

2
static/onyx-scry.js → static/onyx.js
View file

@ -1200,7 +1200,7 @@ class MapHandler {
} }
} }
MapHandler.instance = null; MapHandler.instance = null;
const helpLink = "<br>ONYX/scry v0.2.0 [ <a target='_blank' href='https://nilfm.cc/git/onyx-scry/about/LICENSE'>license</a> | <a target='_blank' href='https://nilfm.cc/git/onyx-scry/about'>manual</a> ]"; const helpLink = "<br>ONYX v0.3.0 [ <a target='_blank' href='https://nilfm.cc/git/onyx/about/LICENSE'>license</a> | <a target='_blank' href='https://nilfm.cc/git/onyx/about'>manual</a> ]";
function init() { function init() {
let overlays = new OverlayState(); let overlays = new OverlayState();
try { try {