<!--
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you 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.
#
-->

## Overview
The Newtron Flash File System (NFFS) is a flash file system with the following
priorities:

* Minimal RAM usage
* Reliability

## RTOS support
NFFS currently supports the following operating systems:

* [Mynewt](https://github.com/apache/mynewt-core)
* [Zephyr](https://github.com/zephyrproject-rtos/zephyr)

## Repository
The source code for NFFS lives in the following repository on GitHub:
* https://github.com/apache/mynewt-nffs

All changes to the NFFS codebase should be submitted as Pull Request to the repository above. 

## Issues
Issues must be reported to the Mynewt Jira: https://issues.apache.org/jira/projects/MYNEWT
Use the 'NFFS' component when reporting bug against the Apache Mynewt project.