Browse Source

Adding starting documentation

add-file-preservation
Drew Short 4 years ago
commit
b5434f1f66
  1. 13
      LICENSE.md
  2. 32
      README.md

13
LICENSE.md

@ -0,0 +1,13 @@
Copyright 2020 Drew Short
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

32
README.md

@ -0,0 +1,32 @@
Asset Compression Helper
========================
## About
This tool exists to help compress, store, retrieve and validate media for games. The goal is to provide a simple workflow for checking assets for changes, generating new compressed versions based on those changes, storing those changed versions, and retrieving compressed files.
This tool is designed to work with an S3 compatible bucket storage provider.
## Requirements
- An S3 Compatible Storage Service
- Python 3.7+
- FFMpeg for jpeg, video, and audio compression
- OptiPNG for png optimization
## Using
### Configuring Profiles
### Checking For Changed Assets
### Compressing Changed Assets
### Uploading Changed Assets
### Downloading Assets
## Contributing
## License
See [LICENSE.md](LICENSE.md)
Loading…
Cancel
Save