Skip to content

SpiceQL Documentation #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

chkim-usgs
Copy link
Contributor

@chkim-usgs chkim-usgs commented Feb 18, 2025

[WIP]

Current outline is two pages under "Getting Started":

Using SpiceQL
- Exploring SpiceQL's REST, Python, and C++ APIs
- Visualizing with pyspiceql

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.


### Examples

(Need to update URL with public facing one)
Copy link
Contributor

@jrcain-usgs jrcain-usgs Mar 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is something we developers would need to do in the future, we should open an issue to update the URL instead of leaving a note here.

If it's for users I would word it differently, like "These are examples for running SpiceQL locally at localhost:8080. You can swap the base url for [public URL] to use SpiceQL online."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants